home *** CD-ROM | disk | FTP | other *** search
/ Beginning Mac Programming / Beginning Mac Programming.bin / Open Me for REALbasic 3 / REALbasic 3.2 / Example Projects / Applications / Nathan's Examples / Help Bot / Help Bot Docs next >
Text File  |  1999-02-22  |  2KB  |  41 lines

  1. HelpBot v1.0   02/22/99
  2. - by Virtual1
  3.  
  4.  
  5. HelpBot is a simple bot based on HotSocket 1.5.4, and uses private chat to provide users with information.
  6.  
  7. When you first run HelpBot, fill in all the boxes with the appropriate information, and click (Connect).  The "Edit PW" is for editing, you can leave it as-is for now, but be sure to change it before opening the bot for business, so to speak!  At this time it does not save information entered on this window.
  8.  
  9. It will create a default help system, which is just a single Note.  There are basically two objects in this help system - Notes and Menus.  Menus contain other menus and notes.  In this version, there are a maximum of 9 items per menu.
  10.  
  11. When just using the bot, you can type a number to move to that menu/note, back up one menu, or go to the main menu.  After typing the edit password, you will have more commands available.  They are:
  12.  
  13. Title
  14. Example: T Hello World
  15. Effect: changes the title (text as shown in the menu/note's parent menu) to "Hello World"
  16. Notes: since the 'root' menu is never shown IN a menu, you cannot change its title
  17.  
  18. Note
  19. Example: N Hello World
  20. Effect: changes the note (text you see when displaying the menu or viewing the note) to "Hello World"
  21.  
  22. Add
  23. Example: A Hello World
  24. Effect: will add a note to the end of the current menu, and set its title (what you see in the menu list) to "Hello World", and will also set the Note body (the larger text you see when selecting the note from the menu) to "Hello World".  If you do not supply a text to add, "(new entry)" will be used.
  25. Notes: you cannot add to a Note, and cannot add to a menu that already contains nine items
  26.  
  27. Insert Menu
  28. Example: I Main Menu
  29. Effect: will replace the current note/menu with a new menu item, setting its Title and Note to "Main Menu", and will set the new menu's first and only item to be the current note/menu.
  30.  
  31. Delete
  32. Example: D
  33. Effect: will delete the current note/menu.  If it is a menu, the menu's only item (if any) will be "pulled" up into its place.
  34. Notes: you cannot delete a menu that contains more than one item.
  35.  
  36.  
  37. That's it!  With those simple commands, you should be able to maintain the database.  I will be adding lots of enhancements in the near future I hope, including saving prefs and a GUI interface for the bot's operator to use.
  38.  
  39.  
  40. - Virtual1
  41.